マクロの使用方法¶

troff(1) のように、マクロは ‘.’ (ドット文字) を行頭に置き、それに続けて 2 文字からなるマクロの名称を指定することによって 呼び出されます。 引数はマクロの後にスペースで区切って指定することができます。 行頭にドット文字を指定することによって troff(1) にそれに続く 2 文字をマクロ名として解釈するよう指示しています。 マクロを起動せずに、ある文脈の行の先頭に ‘.’ (ドット文字) を置くためには、 ‘.’ (ドット) の前にエスケープシーケンス ‘\&’ を指定します。 ‘\&’ は文字通りスペース幅が 0 として解釈され、出力には現れません。

一般的に troff(1) マクロは引数を 9 つまで取ることができ、それ以上指定された引数は無視されます。 -mdoc でのほとんどのマクロは 9 つの引数を取ることができ、 限られた場合にのみ引数は次の行に続けて指定することができます ( 拡張引数 セクションを参照)。 いくつかのマクロは引用符に囲まれた引数を扱うことができます (下の 引数に空白文字を指定する セクションを参照)。

-mdoc での一般テキスト領域とマニュアル領域のほとんどのマクロは特別であり、 その引数のリストは呼び出し可能なマクロ名として 解析 されます。 これは一般テキスト領域またはマニュアル領域のマクロ名に一致し、 呼び出し可能であると判断された引数リストの中の引数は、 実行されるか、それが処理される時に呼び出されることを意味しています。 この場合、引数はマクロ名にも関わらず、 ‘.’ (ドット) で前置されません。 このようにしてたくさんのマクロを入れ子にすることができます。 例えばオプションマクロ ‘.Op’ はフラグマクロ ‘Fl’ と引数マクロ ‘Ar’ を 呼び出して 、オプションのフラグを引数とともに指定することができます。

2 文字からなる文字列をマクロ名として解釈されないようにするには、 その文字列の前にエスケープシーケンス ‘\&’ を指定します。

ここで文字列 ‘Fl’ と ‘Ar’ はマクロとして解釈されていません。 本ドキュメントと関連のクイックリファレンスマニュアル mdoc(7) を通して、 引数リストが呼び出し可能な引数として解析されるマクロは「解析される」、 引数リストから呼び出されることができるマクロは「呼び出し可能」 と表現します。 -mdoc のほとんどすべてのマクロは解析されるのですから、これは技術的には 不謹慎な ことですが、常にマクロを「呼び出し可能である」とか「他のマクロを 呼び出すことができる」と表現するのは面倒なことであるため、 「解析される」という用語が使われています。

引数に空白文字を指定する¶

ひとつ以上の空白文字を含む文字列をひとつの引数として指定したい場合が よくあります。 これは 9 個を越える引数を指定できないという制限に対処したり、 引数のリストにある特有な配置をおこなうことが必要なマクロに引数を指定するような 場合に必要となることがあります。 たとえば、関数マクロ ‘.Fn’ では最初の引数は関数名であり、残りの引数が関数のパラメータであることが 必要です。 ANSI C の括弧で囲まれたパラメータリストにおける関数のパラメータの宣言の規定に より、各パラメータは最低でも 2 語の文字列となります。 たとえば int foo のようになります。

空白を含む引数を指定するには 2 通りの方法があります。 実装における注: 解析の前に個々の引数を再割り当てすることによって、 引用符の間に空白を含めて渡すのが最も便利な方法なのですが、 AT&T の troff のすべてのマクロを実装するには処理速度およびメモリ使用量の点で かなり高価な方法となります。 groff では高価な処理にはなりませんが、移植性のため、この方法は 空白を含めることが最も必要である以下のマクロだけに限っています。

空白を含む文字列を渡すのに、固定空白、すなわち詰め込まれない空白文字 ‘\を使う方法があります。すなわち、空白の前にエスケープ文字’ ‘\’ を指定する方法です。 この方法はどのマクロでも使うことができますが、1 行を越える長さのテキストの 調整の邪魔になるという副作用があります。 troff では固定空白は他の印刷可能文字と同様に扱われ、通常期待されるように、 そこで文字列を空白や改行で分けることを行なわなくなります。 この方法は文字列が行の境界をまたがないであろう場合に有用です。 例えば、

もし ‘\’ や引用符が省かれると、 ‘.Fn’ は引数を 3 つ取り、その結果は

となります。

パラメータのリストが改行の境界をまたぐ場合に何がおこるかについては、 バグ のセクションを参照してください。

行末の空白文字¶

troff は行末に空白文字があると混乱してしまうことがあります。 <空白><行末>の文字シーケンスからすべての空白文字を取り除くのは良い予防策です。 どうしても行末に空白文字をおく必要性が出てきた場合は、 詰め込まれない空白とエスケープ文字 ‘\&’ を使用することによって対応できます。 例えば、 ‘string\ \&’ のようにします。

特殊文字のエスケープ¶

改行 ‘\n’ のような特殊文字は ‘\’ を ‘\e’ で置き換える (すなわち ‘\en’ とする) ことによって、バックスラッシュを残して扱うことができます。

マニュアルページのテンプレート¶

.\" 以下の項目はすべての man ページで必要な項目です。
.Dd 月 日, 年
.Os オペレーティングシステム [バージョン/リリース]
.Dt ドキュメントタイトル [セクション番号] [ボリューム]
.Sh NAME
.Nm 名称
.Nd 名称の 1 行での説明
.Sh SYNOPSIS
.Sh DESCRIPTION
.\" 以下の項目については、必要に応じてコメントをはずして使用してく
.\" ださい。
.\" .Sh IMPLEMENTATION NOTES
.\" この次の項目はセクション 2, 3, 9 でのみ必要な、関数の
.\" 戻り値です。
.\" .Sh RETURN VALUE
.\" 次の項目はセクション 1, 6, 7, 8, 9 でのみ必要なものです。
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
.\" 次の項目はセクション 1, 6, 7, 8, 9 でのみ必要なものです。
.\"     ((シェルへの)コマンドの戻り値と fprintf/stderr の型の診断
.\"      です。)
.\" .Sh DIAGNOSTICS
.\" .Sh COMPATIBILITY
.\" 次の項目はセクション 2, 3, 9 でのみ必要な、エラーハンドリングと
.\" シグナルハンドリングです。
.\" .Sh ERRORS
.\" .Sh SEE ALSO
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh BUGS

このテンプレートにおける最初の項目はマクロ (.Dd, .Os, .Dt) であり、それぞれドキュメントの日付、 man ページもしくは題材となっているソースの開発や変更のベースとなった オペレーティングシステム、 (大文字で) man ページタイトルをそのページが属するマニュアルのセクション番号とともに 指定したもの、となっています。 これらのマクロはそのページを識別するものであり、後述の タイトルマクロ で議論されています。

テンプレート中の残りの項目はセクションのヘッダ (.Sh) であり、それらのうち NAME と SYNOPSIS と DESCRIPTION は必須項目です。 これらのヘッダについては マニュアル領域 を説明した後、 ページ構造領域 で議論されます。 いくつかのコンテントマクロはページレイアウトマクロの説明に 使われていますので、ページレイアウトマクロの前にコンテントマクロについて 読むことを推奨します。

この名前には何が...?¶

マニュアル領域のマクロ名はコマンドやサブルーチン、それに関連ファイルを 説明するために使われている日常のインフォーマルな言葉から取られています。 この言葉と少し違うバリエーションのものが man ページを書く上での 3 つの異なった面を記述するのに使われます。 最初のものは、 -mdoc マクロ使用方法の説明です。 2 番目のものは -mdoc マクロを用いた UNIX コマンドの記述です。 3 番目はコマンドを通常の言葉の感覚でユーザに示したものです。 これはすなわち、man ページのテキスト中でのコマンドの議論となります。

最初のケースでは、 troff(1) マクロはそれ自身、一種のコマンドとなっています。 troff コマンドは一般的に以下のような形式をとります。

‘.Va’ はマクロコマンドもしくは要求を示しており、それに続くものは すべて引数として処理されます。 2 番目のケースでは、コンテントマクロを使用する UNIX コマンドの記述がもう少し含まれます。 典型的な SYNOPSIS コマンド行はこのように表示されます。

ここで filter はコマンド名であり、角括弧で囲まれた文字列 -flag は フラグ 引数で、これは角括弧で囲むことによってオプションであることを示しています。 -mdoc の用語では infile と outfile は 引数 と称されています。 上の例のフォーマットを行なったマクロは以下のものです。

.Nm filter
.Op Fl flag
.Ar infile outfile

3 番目のケースでは、コマンドの説明や構文に上記の例の両方が使われ、 さらに細かい記述が追加されるでしょう。 上の例での引数 infile と outfile は オペランド もしくは ファイル引数 として参照されます。 コマンド行の引数のリストはかなり長くなる場合もあります。

ここではコマンド make について記述しており、 makefile をフラグ -f の引数としています。 またオプションのファイルオペランド target についても議論しています。 言葉での説明では、こういった詳細な記述が混乱を防いでくれますが、 -mdoc パッケージにはフラグ への 引数のためのマクロがありません。 その代わりに target のようなオペランドやファイル引数に使われる引数マクロ ‘Ar’ が variable のようなフラグへの引数にも使われます。 この make コマンド行は以下の指定により生成されています。

.Nm make
.Op Fl eiknqrstv
.Op Fl D Ar variable
.Op Fl d Ar flags
.Op Fl f Ar makefile
.Op Fl I Ar directory
.Op Fl j Ar max_jobs
.Op Ar variable=value
.Bk -words
.Op Ar target ...
.Ek

マクロ ‘.Bk’ と ‘.Ek’ は キープ セクションにおいて解説されています。

一般的な構文¶

マニュアル領域と一般テキスト領域のマクロはいくつかの小さな違い があるものの、同様な構文を使用しています。 ‘.Ar’, ‘.Fl’, ‘.Nm’, ‘.Pa’ は引数なしで呼び出された時のみ異なります。 ‘.Fn’ と ‘.Xr’ は引数のリストの順番が異なります。 マクロ ‘.Op’ と ‘.Fn’ には入れ子の制限があります。 すべてのコンテントマクロが句読点を認識し、正しく扱うには、 各々の句読点文字が先行する空白で分離されている必要があります。 以下のように指定されている場合、

その結果は以下のようになります。

ここでは句読点は認識されずすべての出力はリテラルなフォントで行なわれて います。句読点が空白文字で区切られている場合、

結果は以下のようになります。

今度は句読点が認識され、出力はデフォルトのフォントで行なわれ リテラルフォントの文字列と区別されています。

‘\&’ でエスケープすることによって句読点文字の特別な意味を取り除くことができます。 troff はマクロ言語としての限界から、数学、論理学、もしくは以下の引用符の 集合のメンバを含んだ文字列を表現するのは困難です。

{+,-,/,*,%,<,>,<=,>=,=,==,&,`,',"}

troff が文字によって示唆されている操作もしくは評価を実際に行なっていることが、 その問題の原因となっています。 ‘\&’ でこれらをエスケープすることによって、これらの文字が予期せずに 評価されることを防止することができます。 最初のコンテントマクロは、以下の ‘.Ad’ において、その典型的な構文が示されています。

アドレスマクロ¶

アドレスマクロは addr1[,addr2[,addr3]] の形式からなるアドレスを識別します。

‘.Ad’ を引数なしで呼び出すのはエラーです。 ‘.Ad’ は他のマクロから呼び出し可能で解析されます。

作者名¶

‘.An’ マクロは文書化されている項目の作者の名前、もしくは実際の マニュアルページの作者の名前を指定するために使われます。 名前の情報の後のすべての引数は句読点として扱われます。

‘.An’ マクロは解析され、呼び出し可能です。 ‘.An’ を引数なしで呼び出すのはエラーです。

AUTHORS セクションでは、 ‘.An’ 要求は改行を引き起こし、各新規の名前がそれぞれの行に表示されます。 この動作が望ましくない場合、

.An -nosplit

呼び出しで無効化可能です。 それぞれの行に表示させる動作に戻したい場合は、

.An -split

引数マクロ¶

引数マクロ ‘.Ar’ はコマンド行の引数を参照する際に使用することができます。

‘.Ar’ が引数なしで呼び出されると、 ‘file ...’ として扱われます。 ‘.Ar’ マクロは解析され、呼び出し可能です。

コンフィギュレーション宣言 (セクション 4 のみ)¶

‘.Cd’ マクロはセクション 4 のマニュアルにおいて、デバイスインタフェースの config(8) による宣言の説明に使われます。 このマクロは引用符 (2 重引用符のみ) で囲まれた引数を取ることができます。

コマンド修飾子¶

コマンド修飾子は ‘.Cm’ マクロがすべての引数の前にダッシュ文字を付けないことを除いて、 ‘.Fl’ (フラグ) コマンドと同じです。 伝統的にフラグはダッシュ文字に引き続いて指定されますが、 いくつかのコマンドやコマンドのサブセットはこの方法を使っていません。 コマンド修飾子はエディタコマンドのような対話的なコマンドでも 指定されることがあります。 フラグ のセクションを参照してください。

定義済みの変数¶

インクルードファイルにおいて定義されている変数は ‘.Dv’ マクロによって指定します。

‘.Dv’ を引数なしで呼び出すのはエラーです。 ‘.Dv’ は解析され、呼び出し可能です。

errno (セクション 2 のみ)¶

エラーマクロ ‘.Er’ はセクション 2 のライブラリルーチンにおけるエラーの戻り値を指定します。 下記の 2 番目の例では ‘.Er’ は一般テキスト領域マクロである ‘.Bq’ (これはセクション 2 のマニュアルページで使われています) と共に使われています。

‘.Er’ を引数なしで呼び出すのはエラーです。 ‘.Er’ は解析され、呼び出し可能です。

環境変数¶

‘.Ev’ マクロは環境変数を指定します。

‘.Ev’ を引数なしで呼び出すのはエラーです。 ‘.Ev’ は解析され、呼び出し可能です。

関数の引数¶

‘.Fa’ マクロは関数の引数 (パラメータ) を マニュアルの SYNOPSIS のセクション外、もしくは SYNOPSIS のセクション内で参照する場合に使われます。 パラメータのリストが ‘.Fn’ マクロでは長すぎる場合は、 囲って使うマクロ ‘.Fo’ と ‘.Fc’ を使わなければなりません。 ‘.Fa’ は構造体のメンバを参照する場合にも使われます。

‘.Fa’ を引数なしで呼び出すのはエラーです。 ‘.Fa’ は解析され、呼び出し可能です。

関数の宣言¶

‘.Fd’ マクロは SYNOPSIS セクションにおいて、セクション 2 または 3 の関数の説明で使われます。 ‘.Fd’ マクロから他のマクロを呼び出すことはなく、他のマクロから呼び出すことも できません。

SYNOPSIS セクションにおいて、関数がすでに示されていて改行が入っていない場合、 ‘.Fd’ によって改行が挿入されます。 これによって前の関数呼び出しと次の関数の宣言の間に最適な行間が設定されます。

フラグ¶

‘.Fl’ マクロはコマンド行のフラグを扱います。 フラグの前にはダッシュ ‘-’ が挿入されます。 対話的なコマンドのフラグでは、ダッシュがフラグの前には挿入されませんが、 ‘.Cm’ (コマンド修飾子) マクロは、ダッシュを付けないことを除き、同じ働きをします。

引数なしで ‘.Fl’ マクロを指定すると、標準入力/標準出力を意味するダッシュとなります。 ひとつのダッシュに ‘.Fl’ マクロを使用すると、2 つダッシュとなることに注意して下さい。 ‘.Fl’ マクロは解析され、呼び出し可能です。

関数 (ライブラリルーチン)¶

‘.Fn’ マクロは ANSI C の記法を規範としています。

使い方: .Fn [type] function [[type] parameters ... ]

.Fn getchar

getchar()

.Fn strlen ) ,

strlen()),

.Fn "int align" "const * char *sptrs",

int align(const * char *sptrs),

‘.Fn’ を引数を指定せずに呼び出すのはエラーです。 ‘.Fn’ マクロは解析され、呼び出し可能です。他のマクロの呼び出しは ‘.Fn’ の呼び出しの終了を意味することに注意して下さい (閉じ括弧がその点で挿入されます)。

9 個以上のパラメータをとる関数 (これは滅多にないことですが) では、 ‘.Fo’ マクロ (関数オープン) と ‘.Fc’ マクロ (関数クローズ) を ‘.Fa’ (関数引数) と共に使って、この制限を回避することができます。 以下にその例を示します。

.Ft int
.Fo res_mkquery
.Fa "int op"
.Fa "char *dname"
.Fa "int class"
.Fa "int type"
.Fa "char *data"
.Fa "int datalen"
.Fa "struct rrec *newrr"
.Fa "char *buf"
.Fa "int buflen"
.Fc

これは以下のような結果になります。

‘.Fo’ と ‘.Fc’ マクロは解析され、呼び出し可能です。 SYNOPSIS セクションでは、関数は常に行の先頭から開始されます。 SYNOPSIS セクションにおいて、複数の関数が示されており、関数の型が示されない場合、 改行が挿入され、現在の関数名とその前の関数名の間に最適な改行量が設定されます。 現在、 ‘.Fn’ は troff の行の長さに対して、語の境界をチェックしておらず、予期しない 場所で改行が挿入されてしまうことがあります。 これは近い将来修正されるでしょう。

関数の型¶

このマクロは SYNOPSIS セクションで使うものです。 man ページ中の他の場所でも問題なく使うことができますが、 セクション 2 と 3 の SYNOPSIS セクションでカーネルの通常の形式で関数の型を示すことがこのマクロの目的です (このマクロは関数名が次の行に置かれるように改行を挿入します)。

‘.Ft’ は他のマクロからは呼び出せません。

対話的なコマンド¶

‘.Ic’ マクロは対話的なコマンド、もしくは内部コマンドを指定します。

‘.Ic’ を引数なしで呼び出すのはエラーです。 ‘.Ic’ マクロは解析され、呼び出し可能です。

ライブラリ名¶

‘.Lb’ マクロは、関数がどのライブラリに組み込まれるかを指定します。

‘.Lb’ マクロに対して使用可能な引数と結果は次の通りです:

名称マクロ¶

‘.Nm’ マクロは文書のタイトルやサブジェクト名を指定するために使われます。 このマクロは最初に呼び出された時の引数を覚えておくという特性を持っており、 それは常にそのページのサブジェクト名であるべきです。 引数なしで呼び出されると ‘.Nm’ は作者の作業を少なくするためだけの目的で、最初の名称を出力します。 注: セクション 2 または 3 のドキュメントの関数名は NAME セクションにおいて ‘.Nm’ で指定され、 SYNOPSIS セクションや残りのセクションでは ‘.Fn’ で指定されます。 csh(1) での ‘while’ コマンドのキーワードのような対話的なコマンドでは ‘.Ic’ マクロを使うべきです。 ‘.Ic’ はほとんど ‘.Nm’ と同一ですが、 それが最初に使われたときの引数を記憶することはできません。

‘.Nm’ マクロは解析され、呼び出し可能です。

オプション¶

‘.Op’ マクロはコマンド行の残りのすべての引数を オプションであることを示す角括弧で囲み、 末尾の句読点は角括弧の外に置きます。 ‘.Oc’ マクロと ‘.Oo’ マクロは複数行に渡って使うことができます。

‘.Oc’ マクロと ‘.Oo’ マクロ:

.Oo
.Op Fl k Ar kilobytes
.Op Fl i Ar interval
.Op Fl c Ar count
.Oc

出力結果: [[-k kilobytes] [-i interval] [-c count]]

‘.Op’ と ‘.Oc’ と ‘.Oo’ マクロは解析され、呼び出し可能です。

パス名¶

‘.Pa’ マクロはパス名もしくはファイル名をフォーマットします。

‘.Pa’ マクロは解析され、呼び出し可能です。

規格¶

‘.St’ マクロは、規格の短縮名称を正式名称に置換します。

使用可能な “短縮名称/正式名称” の組は次の通りです:

変数¶

一般的な変数への参照です。

‘.Va’ を引数なしで呼び出すのはエラーです。 ‘.Va’ マクロは解析され、呼び出し可能です。

マニュアルページのクロスリファレンス¶

‘.Xr’ マクロは最初の引数にマニュアルページの名称を取り、もしあれば次の引数に セクションのページ数か句読点を取ります。 すべての残りの引数は句読点と見なされます。

‘.Xr’ マクロは解析され、呼び出し可能です。 ‘.Xr’ を引数なしで呼び出すのはエラーです。

AT&T マクロ¶

使い方: .At [v6 | v7 | 32v | V.1 | V.4] ...

‘.At’ マクロは解析 されず 、呼び出し 不可能 です。 最大 2 つまでの引数を取ることができます。

BSD マクロ¶

‘.Bx’ マクロは解析され、呼び出し可能です。

FreeBSD/NetBSD/OpenBSD マクロ¶

使い方: .Fx [ Version.release ] ...

使い方: .Nx [ Version.release ] ...

使い方: .Ox [ Version.release ] ...

‘.Fx’, ‘.Nx’, ‘.Ox’ マクロは解析され、呼び出し可能です。 最大 2 つまでの引数を取ることができます。

UNIX マクロ¶

‘.Ux’ マクロは解析され、呼び出し可能です。

囲い/クォートマクロ¶

囲いの概念はクォートと似たものです。 1 つ以上の文字列が引用符や括弧のような文字のペアで囲まれている オブジェクトを指します。 クォートと囲いという用語はこの文書を通して同じ意味で使われます。 ほとんどの 1 行の囲いマクロはクォート (quote) のヒントとするために、小文字の ‘q’ で終了しますが、いくつかの例外があります。 各々の囲いマクロに対し、開始マクロと終了マクロのペアもあり、それぞれ小文字の ‘o’ と ‘c’ で終了します。 これらは 1 行以上のテキストに渡って使うことができますが、 入れ子にする場合に制限があります。 その中では 1 行形式のクォートマクロのみ使用することができます。

下記の不正なマクロを除き、すべてのクォートマクロは解析され、呼び出し可能です。 句読点がひとつずつ置かれていて、スペースで区切られていれば、 すべてのクォートマクロは句読点を適切に扱います。 クォートマクロは開く句読点、閉じる句読点 (訳注: 句読点には括弧なども含みます) を調べ、 それが囲む文字列より前か後かを決めます。 これによって、ある程度の入れ子が可能になっています。

.Ec, .Eo

これらのマクロは各々開始および終了の文字列を最初の引数に取ります。

.Ql

リテラルをクォートするマクロは troff では nroff と異なった処理を行ないます。 nroff でフォーマットされた場合、クォート指定されたリテラルは常にクォートされます。 troff でフォーマットされた場合は、アイテムの幅が固定幅文字 3 つ分より 狭い場合にのみクォートされます。 これはリテラル (固定幅) のフォントの変更があまり気づかれないものであるため、 短い文字列を良く見えるようにするためです。

.Pf

プレフィックスマクロは呼び出し可能ではありませんが、解析されます。

.Pf ( Fa name2

は (name2 となります。

‘.Ns’ (空白なし) マクロはサフィックス機能と同様の作用があります。

クォートの例:

囲いマクロの入れ子についての良い例については、 オプションマクロ ‘.Op’ を参照してください。 このマクロは上でリストされているような囲いマクロと同じベースの上に 作られています。 拡張引数リストマクロ ‘.Xo’ と ‘.Xc’ もまた同じルーチンをベースに作られており、 -mdoc マクロの使い方の非常に良い例となっています。

no-op もしくは通常テキストマクロ¶

‘.No’ マクロはマクロコマンド行において、コンテントマクロの構文形式に従うが、 フォーマットされては ならない 単語をハックするものです。

空白なしマクロ¶

‘.Ns’ マクロはマクロ間での不要な空白を除去します。 これはフラグと引数の間に空白を含まない古いスタイルの引数リストを使う場合に 便利です。

注: ‘.Ns’ マクロは他のマクロ名が続かなければ、スペースを除去したあとに ‘.No’ マクロを常に起動します。 ‘.Ns’ マクロは解析され、呼び出し可能です。

セクションのクロスリファレンス¶

‘.Sx’ マクロは同一文書内でのセクションのヘッダへの参照を指定します。 これは解析され、呼び出し可能です。

参考文献と引用¶

以下のマクロは多少なりとも参考文献を扱えるようにと意図したものです。 これらのマクロは、せいぜい参照スタイルの参考文献のサブセットを手動で 作成しやすくする程度です。

‘%’ で始まるマクロは呼び出し不可能ですが、 呼び出し側に戻る商標名マクロだけは解析されます。 (現時点では予期できないことです。) 商標名のみ解析されるのは troff/ditroff の出力をきれいにするためです。

戻り値¶

‘.Rv’ マクロは RETURN VALUE のセクションで使うテキストを生成します。

‘.Rv -std atexit’ これは以下のテキストを生成します。

The atexit() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

-std オプションはセクション 2 と 3 のマニュアルページでのみ有効です。

商標名 (頭字語とタイプ名)¶

商標名マクロは一般的に長さが 2 文字を越えるすべてが大文字の単語用 に使われる小さな大文字のマクロです。

‘.Tn’ マクロは解析され、他のマクロから呼び出し可能です。

拡張引数¶

‘.Xo’ と ‘.Xc’ マクロでマクロの境界における引数リストを拡張することができます。 引数リストは ‘.Op’ のようなすべての引数が 1 行中に指定されていることを前提としている マクロの中では行に渡って拡張することができません。

以下に空白モードマクロをスペーシングをオフにするために使った ‘.Xo’ での例を示します。

.Sm off
.It Xo Sy I Ar operation
.No \en Ar count No \en
.Xc
.Sm on

これは以下のような結果になります。

例をもうひとつ:

.Sm off
.It Cm S No / Ar old_pattern Xo
.No / Ar new_pattern
.No / Op Cm g
.Xc
.Sm on

これは以下のような結果になります。

囲いマクロを使った ‘.Xo’ の他の例: 変数の値をテストして下さい。

.It Xo
.Ic .ifndef
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
.Xc

結果は以下の通りです。

上のすべての例では ‘.It’ (リスト項目) マクロの引数リストに ‘.Xo’ マクロを使用しています。 拡張マクロが使われることはあまりありません。 使われるとすれば、リスト項目の引数リストを拡張する場合です。 残念なことに、これが拡張マクロが最も懲り性であるところでもあります。 最初の 2 つの例では、スペーシングはオフになっています。 3 番目では、ある箇所にはスペーシングを入れることが望ましいのですが、 出力全体に入れたいわけではありません。 そのような状況でこれらのマクロが適切に動作するためには、 ‘.Xo’ と ‘.Xc’ マクロが 3 番目の例にあるように指定されていることを確認してください。 ‘.Xo’ マクロが置かれた ‘.It’ の引数リストに他のものが置かれると、スペーシングがどうなるかは予測不可能です。 この場合、 ‘.Ns’ (空白なしマクロ) は行中の最初もしくは最後のマクロに指定してはいけません。 現在 BSD でリリースされている 900 のマニュアルページ (実際のページでは約 1500 ページ) のうち 15 のマニュアルページでのみしか ‘.Xo’ が使われていません。

セクションヘッダ¶

以下にリストされている、最初の 3 つのセクションヘッダマクロ ‘.Sh’ はすべての man ページで必須のものです。 残りのセクションヘッダはマニュアルページの作者の裁量において、 推奨されているものです。 ‘.Sh’ マクロは 9 つまでの引数を取ることができます。 これは解析されますが、呼び出し不可能です。

.Sh NAME

‘.Sh NAME (訳注: 名称)’ マクロは必須のものです。 これが指定されていないと、ヘッダとフッタ、それにデフォルトの ページレイアウトが設定されず、結果はかなり好ましくないものになるでしょう。 NAME セクションは最低 3 つの項目からなります。 最初のものは名称マクロ ‘.Nm’ であり、man ページのサブジェクトとなります。 2 番目のものは名称説明マクロ ‘.Nd’ であり、サブジェクト名を 3 つめの項目、 すなわちその名称の説明と分離します。 説明に割り当てられるスペースは小さいものですので、 できるだけ簡潔で分かりやすいものでなければなりません。

.Sh SYNOPSIS

SYNOPSIS (訳注: 書式) セクションはその man ページのサブジェクトとなっている項目の 典型的な使用法を説明します。 必須のマクロは ‘.Nm’, ‘.Cd’, ‘.Fn’ のいずれかです。 (他には ‘.Fo’, ‘.Fc’, ‘.Fd’, ‘.Ft’ のマクロも必要な場合があります。) 関数名マクロ ‘.Fn’ はセクション 2 と 3 のマニュアルページにおいて必須のもので、 コマンドと一般名称マクロ ‘.Nm’ はセクション 1, 5, 6, 7, 8 で必須の項目です。 セクション 4 のマニュアルでは ‘.Nm’ か ‘.Fd’ 、もしくはコンフィギュレーションデバイス使用法マクロ ‘.Cd’ が必要です。 その他のいくつかのマクロが下に示すような書式行を生成するために必要なこと があります。

cat [-benstuv] [-] file ...

以下のマクロが使われています。

.Nm cat

.Op Fl benstuv

.Op Fl

.Ar

注: マクロ ‘.Op’, ‘.Fl’, ‘.Ar’ はパイプの文字 ‘|’ を認識し、下記のようなコマンド行

.Op Fl a | Fl b

はうまくいきません。 troff は通常 | を特別のオペレータとして解釈します。 この他で | が使える場合については 定義済みの文字列 セクションを参照して下さい。

.Sh DESCRIPTION

DESCRIPTION (訳注: 解説) セクションでの最初のテキストは、ほとんどの場合ではそのコマンド、 関数もしくはファイルについての短い段落で、オプションの構文リストと それぞれの説明がそれに続きます。 そのようなリストを作成するには リスト開始マクロ ‘.Bl’ 、リスト項目マクロ ‘.It’ 、リスト終了マクロ ‘.El’ を使います (後述の リストと列 セクションを参照)。

以下の ‘.Sh’ のセクションヘッダはマニュアルページの好ましいレイアウトの一部であり、 一貫性を保つために適切に使われなければなりません。 これらは使われる順番にリストされています。

.Sh ENVIRONMENT (訳注: 環境変数)

ENVIRONMENT セクションは関連する環境変数を明らかにし、 それらの振舞や使用方法を示します。

.Sh EXAMPLES (訳注: 使用例、実行例)

使用例、実行例を作成するには様々な方法があります。 詳細については、下の 例示とディスプレイ のセクションを参照してください。

.Sh FILES (訳注: 関連ファイル)

man ページのサブジェクトによって使用されるか生成されるファイルで、 FILES のセクション中でマクロ ‘.Pa’ によってリストされます。

.Sh SEE ALSO (訳注: 関連項目)

SEE ALSO セクションには、その man ページの題材に関する資料への参照と 他の関連する man ページへのクロスリファレンスが記載されます。 クロスリファレンスは ‘.Xr’ マクロによって指定されます。 SEE ALSO セクションでのクロスリファレンスはセクション番号順に並べ、 セクション中ではカンマで区切ってアルファベット順に並べなければなりません。 以下に例を示します。

ls(1), ps(1), group(5), passwd(5)

ここで参考スタイルである refer(1) は適応されていません。

.Sh STANDARDS (訳注: 規格)

コマンドやライブラリ関数やファイルが、 IEEE Std 1003.2 (“POSIX.2”) や ANSI X3.159-1989 (“ANSI C89”) のような特定の実装によるものであれば、ここで記述します。 もしコマンドがどの規格にも基づいていなければ、その歴史は HISTORY のセクションで説明されなければなりません。

.Sh HISTORY (訳注: 歴史)

特定の規格に基づいていないコマンドは、 このセクションでその歴史の概要が説明されるべきです。

.Sh AUTHORS (訳注: 作者)

クレジットが必要であれば、ここで入れます。 人物名を指定するには ‘.An’ マクロを使用すべきです。

.Sh DIAGNOSTICS (訳注: 診断)

コマンドからの診断はこのセクションに入れます。

.Sh ERRORS (訳注: エラー)

特定のエラーハンドリング、特にライブラリ関数 (man ページのセクション 2, 3, 9) でのエラーハンドリングは、ここで説明します。 ‘.Er’ マクロが errno を記述するために使われます。

.Sh BUGS (訳注: バグ)

あきらかな問題はここで記述します。

ユーザ指定の ‘.Sh’ セクションを追加することができます。 たとえば、このセクションは以下のように設定されています。

.Sh ページ構造領域

段落と行スペース¶

.Pp

‘.Pp’ 段落コマンド は必要な場合に行スペースを指定するために使われます。 このマクロは ‘.Sh’ マクロや ‘.Ss’ マクロのあと、それに ‘.Bl’ マクロの前では必要ありません。 ( ‘.Bl’ マクロは -compact フラグが指定されていなければ、縦方向の距離を宣言します )。

キープ¶

現在実装されているキープは単語に対するものだけです。 それらは ‘.Bk’ (キープ開始) マクロと ‘.Ek’ (キープ終了) マクロです。 ‘.Bk’ に指定できるオプションは -words のみであり、これはオプションの途中で改行が入らないようにするのに便利です。 コマンド行の引数を生成する例 ( この名前には何が...? セクションを参照) において、キープは nroff がフラグと引数を別の行に分けないように使われています。 (実際には、オプションマクロがこの目的で使われていましたが、 オプションが行中にわたって散らばってしまうと 一般的に見栄えが悪くなるという理由により troff で右揃えのマージンを強制的に行なう (宗教的な) 決定がなされてから、 オプションマクロをこの目的で使わないようになりました。 キープマクロについてはもっと機能を向上する作業が必要であり、 -line オプションを追加していく必要があります。)

例示とディスプレイ¶

ディスプレイには 5 つのタイプがあります。 即席 1 行インデントディスプレイ ‘.D1’ 、即席 1 行リテラルディスプレイ ‘.Dl’ 、それに ディスプレイ開始マクロ ‘.Bd’ とディスプレイ終了マクロ ‘.Ed’ を使用するリテラルブロック、フィルブロックおよび凸凹ブロックです。

.D1

(D-いち) インデントされたテキストを 1 行表示します。 このマクロは解析されますが、呼び出し不可能です。

-ldghfstru

これは次の指定で生成されたものです。 .D1 Fl ldghfstru

.Dl

(D-エル) インデントされた リテラル テキストを 1 行表示します。 ‘.Dl’ マクロの例は本ファイルの中に渡って使われています。 これによって 1 行のテキストのインデント (表示) が可能になります。 このマクロは解析され、他のマクロを認識することができますが、 デフォルトのフォントは固定幅 (リテラル) にセットされています。 しかしながら、呼び出しは不可能です。

% ls -ldg /usr/local/bin

これは .Dl % ls -ldg /usr/local/bin から生成されています。

.Bd

ディスプレイ開始です。 ‘.Bd’ によるディスプレイは ‘.Ed’ マクロによって終了しなければなりません。 ディスプレイはディスプレイ内およびリスト内で入れ子にすることができます。 ‘.Bd’ は以下の書式をとります。

.Bd ディスプレイタイプ [-offset オフセット値] [-compact]

ディスプレイタイプは以下の 4 つのタイプの内の 1 つでなければならず、 インデント ‘.Bd’ のオフセット値を指定することができます。

-ragged

テキストのブロックをタイプされた通りに表示します。 右マージン (と左マージン) のエッジは左に不揃いに寄せられます。

-filled

フィル (フォーマット) されたブロックを表示します。 テキストのブロックがフォーマットされます (エッジは左非揃えではなく、フィルされます)。

-literal

リテラルなブロックを表示します。 ソースコードや、単純にタブもしくはスペースで整えられたテキストで便利です。

-file ファイル名

-file フラグに続く名称のファイルが読み込まれ、表示されます。 表示はリテラルなモードで行われ、タブは定幅文字 8 つ分に固定されますが、 ファイル中のすべての troff/-mdoc コマンドは解釈されます。

-offset 文字列

-offset が以下の文字列のいずれかとともに指定されていると、 その文字列は次のテキストのブロックのインデントのレベルを示すものとして 解釈されます。

left

ブロックを現在の左マージンに揃えます。 これは ‘.Bd’ のデフォルトのモードです。

center

ブロックを中央揃えにします。 残念ながら現時点では、 単にブロックの左側を仮想的な中央マージンに揃えるだけです。

indent

デフォルトのインデント値もしくはタブの分だけインデントします。 デフォルトのインデント値はディスプレイ ‘.D1’ でも使われ、これら 2 つのタイプのディスプレイを使った場合、 行が揃うことが保証されています。 このインデントは通常 6n か約 2/3 インチ (定幅文字 6 つ分) です。

indent-two

デフォルトのインデント値の 2 倍分インデントします。

right

これはブロックをページの右端から約 2 インチ離して 左 揃えします。 このマクロはちゃんと動作する必要があるのですが、 troff ではまったくちゃんと動作してくれていません。

.Ed

ディスプレイ終了。

フォントモード¶

マニュアルページのテキストの見栄えを変更するマクロは 5 つあります。

.Em

テキストは ‘.Em’ マクロで強調することができます。 強調の場合、通常イタリック体のフォントが使われます。

使い方: .Em argument ...

.Em does not

does not

.Em exceed 1024 .

exceed 1024.

.Em vide infra ) ) ,

vide infra)),

‘.Em’ マクロは解析され、呼び出し可能です。 ‘.Em’ を引数なしで呼び出すのはエラーです。

.Li

リテラルマクロ ‘.Li’ は特殊文字や変数定数、その他タイプされた通りに表示する必要があるものに 使用することができます。

使い方: .Li argument ...

.Li \en

\n

.Li M1 M2 M3 ;

M1 M2 M3;

.Li cntrl-D ) ,

cntrl-D),

.Li 1024 ...

1024 ...

‘.Li’ マクロは解析され、呼び出し可能です。

.Sy

シンボリック体強調マクロはシンボリックの意味でも 伝統的な英語の使いかたにおいても、 通常はボールドマクロとなっています。

使い方: .Sy symbol ...

.Sy Important Notice

Important Notice

‘.Sy’ マクロは解析され、呼び出し可能です。 ‘.Sy’ の引数は引用符で囲むことができます。

.Bf

フォントモード開始。 フォントモード ‘.Bf’ は ‘.Ef’ マクロで終了しなければなりません。 フォントモードは他のフォントモードと入れ子にすることができます。 ‘.Bf’ は次の構文を取ります。

.Bf フォントモード

フォントモードは以下の 3 つのタイプのうちのいずれかでなければなりません。

Em | -emphasis

強調モード。 ‘.Em’ マクロがテキストブロック全体に使われているのと同様です。

Li | -literal

リテラルモード。 ‘.Li’ マクロがテキストブロック全体に使われているのと同様です。

Sy | -symbolic

シンボリックモード。 ‘.Sy’ マクロがテキストブロック全体に使われているのと同様です。

.Ef

フォントモードの終了。

タグつきリストと列¶

リスト開始マクロ ‘.Bl’ で開始されるリストにはいくつかのタイプがあります。 リスト中の項目は項目マクロ ‘.It’ で指定され、各リストは ‘.El’ マクロで終了しなければなりません。 リストはリスト自身やディスプレイの中で入れ子にすることができます。 列はリストの中で使うことができますが、 リストが列の中で使えるかどうかは検証されていません。

さらに、タグの幅、リストのオフセット、コンパクトさ (項目間の空白行が許されているかどうか) のような、 いくつかのリストの属性を指定することができます。 本ドキュメントのほとんどはタグ (-tag) スタイルリストでフォーマットされています。 各種リストタイプは、調子を変えるためにオーバーハング (-ohang) でリストしました。 このリストのタイプは TeX のユーザに非常に人気のあるものですが、tag リストで構成されたページを 何ページも読んだ後には幾分変に見えるでしょう。 以下のリストタイプを ‘.Bl’ で使うことができます。

-bullet

-item

-enum

これら 3 つは最も単純なリストのタイプです。 一旦 ‘.Bl’ マクロが与えられると、リスト中の項目は単に ‘.It’ マクロによってのみ構成される行で指定されます。 例として、簡単な列挙リストのソーステキストは、このようになります。

.Bl -enum -compact
.It
ひとつめはここ。
.It
そしてふたつめ。
.It
最後にみっつめはここ。
.El

これらの結果は以下のようになります。

1. ひとつめはここ。
2. そしてふたつめ。
3. 最後にみっつめはここ。

簡単な bullet リスト構成の例を示します。

.Bl -bullet -compact
.It
ひとつめの bullet。
.It
これはふたつめの bullet。
.El

その結果はこうなります。

• ひとつめの bullet。
• これはふたつめの bullet。

-tag

-diag

-hang

-ohang

-inset

これらのリストタイプは ‘.It’ マクロによって指定されている引数からラベルを生成します。 そして、 inset では、次のテキストへそのラベルを挿入します。 hang では、次のテキストをラベルの位置へインデントします。 ohang (オーバーハング) では、次のテキストをラベルの位置にぶら下げ、インデントしません。 tag では、タグつきテキストの形式にします。 ちなみに上のリストは ‘-ohang’ リストタイプで構成されています。 ‘.It’ マクロは inset, hang, tag のリストタイプでのみ解析され、 呼び出し不可能です。 以下に inset ラベルの例を示します。

tag

tag リスト (tag 段落とも呼ばれる) は、 Berkely マニュアルで使われているリストのうち最も一般的なタイプです。

diag (診断)

診断リストはセクション 4 の診断リストを生成するもので、 呼び出し可能なマクロが無視されることを除き、inset リストと似ています。

hang

hang ラベルは好みの問題です。

ohang

ohang ラベルはスペースに制限がある時に便利です。

inset

inset ラベルは段落のブロックを制御するのに便利で、 -mdoc マニュアルを他の形式に変換する時に役立ちます。

上の例を生成したソーステキストはこうなっています。

.Bl -inset -offset indent
.It Em tag
tag リスト (tag 段落とも呼ばれる) は、
Berkely マニュアルで使われているリストのうち最も一般的なタイプです。
.It Em diag (診断)
診断リストはセクション 4 の診断リストを生成するもので、
呼び出し可能なマクロが無視されることを除き、inset リストと似ています。
.It Em hang
hang ラベルは好みの問題です。
.It Em ohang
ohang ラベルはスペースに制限がある時に便利です。
.It Em inset
inset ラベルは段落のブロックを制御するのに便利で、
.Nm -mdoc
マニュアルを他の形式に変換する時に役立ちます。
.El

以下は 2 つの項目を持つ hang リストです。

hang

ラベルがラベルの幅より小さいときには、 ラベルは tag リストと同じようになります。

長い hang リストラベル

は、tag 段落のラベルとは異なり、 段落の中に埋め込まれます。

これを生成している元のテキストは以下の通りです。

.Bl -hang -offset indent
.It Em hang
ラベルがラベルの幅より小さいときには、
ラベルは tag リストと同じようになります。
.It Em 長い hang リストラベル
は、tag 段落のラベルとは異なり、
段落の中に埋め込まれます。
.El

タグ幅を制御するためのオプションの幅指定を使ったタグつきリストは 以下の通りです。

SL

プロセスが sleep している時間 (ブロックされた秒数)

PAGEIN

そのプロセスによるコアにロードされていないページへの参照によるディスク I/O の回数

UID

プロセスの所有者の数字表記によるユーザID

PPID

親プロセスの数字表記によるID、プロセスの優先度 (割り込み不可のウエイトであるときには非正値)

元のテキストは以下の通りです。

.Bl -tag -width "PAGEIN" -compact -offset indent
.It SL
プロセスが sleep している時間 (ブロックされた秒数)
.It PAGEIN
そのプロセスによるコアにロードされていないページへの参照によるディスク
.Tn I/O
の回数
.It UID
プロセスの所有者の数字表記によるユーザID
.It PPID
親プロセスの数字表記によるID、プロセスの優先度
(割り込み不可のウエイトであるときには非正値)
.El

幅指定として以下のものを使うことができます。

-width Fl

そのフラグでのデフォルトの幅を指定します。 すべての呼び出し可能なマクロは各々デフォルトの幅の値を持っています。 現在、 ‘.Fl’ の値は定幅文字 10 個分、もしくは約 5/6 インチとなっています。

-width 24n

定幅文字 24 個分の幅、もしくは約 2 インチの幅をセットします。 これが正しく動作するには ‘n’ が必ず必要となります。

-width ENAMETOOLONG

指定された文字列の固定長に幅をセットします。

-width "int mkfifo"

これも、指定された文字列の固定長に幅をセットします。

タグつきリストタイプで幅が指定されていないと、 ‘.It’ が最初に起動された時に適した幅を決定することが試みられます。 ‘.It’ の最初の引数が呼び出し可能なマクロであれば、そのマクロのデフォルトの幅が そのマクロ名が幅として指定されたように使用されます。 しかしながら、そのリスト中に他の項目が別の呼び出し可能なマクロ名で 与えられていると、新しく入れ子となったリストとして処理されます。